org.springframework.test.context.junit.jupiter

Class SpringExtension

java.lang.Object

org.springframework.test.context.junit.jupiter.SpringExtension

public class SpringExtension
extends java.lang.Object

SpringExtension integrates the Spring TestContext Framework into JUnit 5's Jupiter programming model.

To use this extension, simply annotate a JUnit Jupiter based test class with @ExtendWith(SpringExtension.class), @SpringJUnitConfig, or @SpringJUnitWebConfig.

Since:

5.0

Author:

Sam Brannen

See Also:

EnabledIf, DisabledIf, SpringJUnitConfig, SpringJUnitWebConfig, TestContextManager

Field Summary

Fields

Modifier and Type	Field and Description
private static Namespace	NAMESPACE Namespace in which TestContextManagers are stored, keyed by test class.

Constructor Summary

Constructors

Constructor and Description
SpringExtension()

Method Summary

Modifier and Type	Method and Description
void	afterAll(ExtensionContext context) Delegates to TestContextManager.afterTestClass().
void	afterEach(ExtensionContext context) Delegates to TestContextManager.afterTestMethod(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).
void	afterTestExecution(ExtensionContext context) Delegates to TestContextManager.afterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).
void	beforeAll(ExtensionContext context) Delegates to TestContextManager.beforeTestClass().
void	beforeEach(ExtensionContext context) Delegates to TestContextManager.beforeTestMethod(java.lang.Object, java.lang.reflect.Method).
void	beforeTestExecution(ExtensionContext context) Delegates to TestContextManager.beforeTestExecution(java.lang.Object, java.lang.reflect.Method).
static ApplicationContext	getApplicationContext(ExtensionContext context) Get the ApplicationContext associated with the supplied ExtensionContext.
private static Store	getStore(ExtensionContext context)
private static TestContextManager	getTestContextManager(ExtensionContext context) Get the TestContextManager associated with the supplied ExtensionContext.
void	postProcessTestInstance(java.lang.Object testInstance, ExtensionContext context) Delegates to TestContextManager.prepareTestInstance(java.lang.Object).
java.lang.Object	resolveParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Resolve a value for the Parameter in the supplied ParameterContext by retrieving the corresponding dependency from the test's ApplicationContext.
boolean	supportsParameter(ParameterContext parameterContext, ExtensionContext extensionContext) Determine if the value for the Parameter in the supplied ParameterContext should be autowired from the test's ApplicationContext.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMESPACE

private static final Namespace NAMESPACE

Namespace in which TestContextManagers are stored, keyed by test class.

Constructor Detail

SpringExtension

public SpringExtension()

Method Detail

beforeAll

public void beforeAll(ExtensionContext context)
               throws java.lang.Exception

Delegates to TestContextManager.beforeTestClass().

Throws:

java.lang.Exception

afterAll

public void afterAll(ExtensionContext context)
              throws java.lang.Exception

Delegates to TestContextManager.afterTestClass().

Throws:

java.lang.Exception

postProcessTestInstance

public void postProcessTestInstance(java.lang.Object testInstance,
                                    ExtensionContext context)
                             throws java.lang.Exception

Delegates to TestContextManager.prepareTestInstance(java.lang.Object).

Throws:

java.lang.Exception

beforeEach

public void beforeEach(ExtensionContext context)
                throws java.lang.Exception

Delegates to TestContextManager.beforeTestMethod(java.lang.Object, java.lang.reflect.Method).

Throws:

java.lang.Exception

beforeTestExecution

public void beforeTestExecution(ExtensionContext context)
                         throws java.lang.Exception

Delegates to TestContextManager.beforeTestExecution(java.lang.Object, java.lang.reflect.Method).

Throws:

java.lang.Exception

afterTestExecution

public void afterTestExecution(ExtensionContext context)
                        throws java.lang.Exception

Delegates to TestContextManager.afterTestExecution(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).

Throws:

java.lang.Exception

afterEach

public void afterEach(ExtensionContext context)
               throws java.lang.Exception

Delegates to TestContextManager.afterTestMethod(java.lang.Object, java.lang.reflect.Method, java.lang.Throwable).

Throws:

java.lang.Exception

supportsParameter

public boolean supportsParameter(ParameterContext parameterContext,
                                 ExtensionContext extensionContext)

Determine if the value for the Parameter in the supplied ParameterContext should be autowired from the test's ApplicationContext.

Returns true if the parameter is declared in a Constructor that is annotated with @Autowired and otherwise delegates to ParameterAutowireUtils.isAutowirable(java.lang.reflect.Parameter).

WARNING: If the parameter is declared in a Constructor that is annotated with @Autowired, Spring will assume the responsibility for resolving all parameters in the constructor. Consequently, no other registered ParameterResolver will be able to resolve parameters.

See Also:

resolveParameter(ParameterContext, ExtensionContext), ParameterAutowireUtils.isAutowirable(java.lang.reflect.Parameter)

resolveParameter

@Nullable
public java.lang.Object resolveParameter(ParameterContext parameterContext,
                                                   ExtensionContext extensionContext)

Resolve a value for the Parameter in the supplied ParameterContext by retrieving the corresponding dependency from the test's ApplicationContext.

Delegates to ParameterAutowireUtils.resolveDependency(java.lang.reflect.Parameter, java.lang.Class<?>, org.springframework.context.ApplicationContext).

See Also:

supportsParameter(ParameterContext, ExtensionContext), ParameterAutowireUtils.resolveDependency(java.lang.reflect.Parameter, java.lang.Class<?>, org.springframework.context.ApplicationContext)

getApplicationContext

public static ApplicationContext getApplicationContext(ExtensionContext context)

Get the ApplicationContext associated with the supplied ExtensionContext.

Parameters:

context - the current ExtensionContext (never null)

Returns:

the application context

Throws:

java.lang.IllegalStateException - if an error occurs while retrieving the application context

See Also:

TestContext.getApplicationContext()

getTestContextManager

private static TestContextManager getTestContextManager(ExtensionContext context)

Get the TestContextManager associated with the supplied ExtensionContext.

Returns:

the TestContextManager (never null)

getStore

private static Store getStore(ExtensionContext context)